home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3c / addseverity.z / addseverity
Encoding:
Text File  |  1998-10-20  |  7.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaaddddddddsssseeeevvvveeeerrrriiiittttyyyy((((3333CCCC))))                                                aaaaddddddddsssseeeevvvveeeerrrriiiittttyyyy((((3333CCCC))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy - build a list of severity levels for an application for use
  10.      with _ffff_mmmm_tttt_mmmm_ssss_gggg
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ffff_mmmm_tttt_mmmm_ssss_gggg_...._hhhh_>>>>
  14.  
  15.      _iiii_nnnn_tttt _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy_((((_iiii_nnnn_tttt _ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy_,,,, _cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_ssss_tttt_rrrr_iiii_nnnn_gggg_))))_;;;;
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      The _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy function builds a list of severity levels for an
  19.      application to be used with the message formatting facility, _ffff_mmmm_tttt_mmmm_ssss_gggg.
  20.      _s_e_v_e_r_i_t_y is an integer value indicating the seriousness of the condition,
  21.      and _s_t_r_i_n_g is a pointer to a string describing the condition (string is
  22.      not limited to a specific size).
  23.  
  24.      If _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy is called with an integer value that has not been
  25.      previously defined, the function adds that new severity value and print
  26.      string to the existing set of standard severity levels.
  27.  
  28.      If _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy is called with an integer value that has been previously
  29.      defined, the function redefines that value with the new print string.
  30.      Previously defined severity levels may be removed by supplying the _NNNN_UUUU_LLLL_LLLL
  31.      string.  If _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy is called with a negative number or an integer
  32.      value of 0, 1, 2, 3, or 4, the function fails and returns -1.  The values
  33.      0-4 are reserved for the standard severity levels and cannot be modified.
  34.      Identifiers for the standard levels of severity are:
  35.  
  36.           _MMMM_MMMM______HHHH_AAAA_LLLL_TTTT       indicates that the application has encountered a
  37.                         severe fault and is halting.  Produces the print
  38.                         string HALT.
  39.  
  40.           _MMMM_MMMM______EEEE_RRRR_RRRR_OOOO_RRRR      indicates that the application has detected a fault.
  41.                         Produces the print string ERROR.
  42.  
  43.           _MMMM_MMMM______WWWW_AAAA_RRRR_NNNN_IIII_NNNN_GGGG    indicates a condition that is out of the ordinary,
  44.                         that might be a problem, and should be watched.
  45.                         Produces the print string WARNING.
  46.  
  47.           _MMMM_MMMM______IIII_NNNN_FFFF_OOOO       provides information about a condition that is not in
  48.                         error.  Produces the print string INFO.
  49.  
  50.           _MMMM_MMMM______NNNN_OOOO_SSSS_EEEE_VVVV      indicates that no severity level is supplied for the
  51.                         message.
  52.  
  53.      Severity levels may also be defined at run time using the _SSSS_EEEE_VVVV______LLLL_EEEE_VVVV_EEEE_LLLL
  54.      environment variable [see _ffff_mmmm_tttt_mmmm_ssss_gggg(3C)].
  55.  
  56. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  57.      When the function _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy is used as follows:
  58.           _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy_((((_7777_,,,,_""""_AAAA_LLLL_EEEE_RRRR_TTTT_""""_))))
  59.      the following call to _ffff_mmmm_tttt_mmmm_ssss_gggg:
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaddddddddsssseeeevvvveeeerrrriiiittttyyyy((((3333CCCC))))                                                aaaaddddddddsssseeeevvvveeeerrrriiiittttyyyy((((3333CCCC))))
  71.  
  72.  
  73.  
  74.           _ffff_mmmm_tttt_mmmm_ssss_gggg_((((_MMMM_MMMM______PPPP_RRRR_IIII_NNNN_TTTT_,,,, _""""_UUUU_XXXX_::::_cccc_aaaa_tttt_""""_,,,, _7777_,,,, _""""_iiii_nnnn_vvvv_aaaa_llll_iiii_dddd _ssss_yyyy_nnnn_tttt_aaaa_xxxx_""""_,,,, _""""_rrrr_eeee_ffff_eeee_rrrr _tttt_oooo _mmmm_aaaa_nnnn_uuuu_aaaa_llll_""""_,,,,
  75.           _""""_UUUU_XXXX_::::_cccc_aaaa_tttt_::::_0000_0000_1111_""""_))))
  76.      produces:
  77.           UX:cat: ALERT: invalid syntax
  78.           TO FIX: refer to manual   UX:cat:001
  79.  
  80. NNNNOOOOTTTTEEEESSSS
  81.      A slightly different standard error message format and new developer
  82.      interfaces, pfmt, _llll_ffff_mmmm_tttt, and _aaaa_dddd_dddd_ssss_eeee_vvvv, are being introduced as the
  83.      replacements for fmtmsg _aaaa_nnnn_dddd _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy_....  _ffff_mmmm_tttt_mmmm_ssss_gggg _aaaa_nnnn_dddd _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy _wwww_iiii_llll_llll _bbbb_eeee
  84.      _rrrr_eeee_mmmm_oooo_vvvv_eeee_dddd _aaaa_tttt _aaaa _ffff_uuuu_tttt_uuuu_rrrr_eeee _tttt_iiii_mmmm_eeee_....
  85.  
  86.  
  87. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  88.      _ffff_mmmm_tttt_mmmm_ssss_gggg(1M), _ffff_mmmm_tttt_mmmm_ssss_gggg(3C), _gggg_eeee_tttt_tttt_xxxx_tttt(3C), _pppp_rrrr_iiii_nnnn_tttt_ffff(3S).
  89.  
  90. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  91.      _aaaa_dddd_dddd_ssss_eeee_vvvv_eeee_rrrr_iiii_tttt_yyyy returns _MMMM_MMMM______OOOO_KKKK on success or _MMMM_MMMM______NNNN_OOOO_TTTT_OOOO_KKKK on failure.
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.